oracle.pgx.api

## Enum PoolType

- java.lang.Object
- - java.lang.Enum<PoolType>
  - - oracle.pgx.api.PoolType

- All Implemented Interfaces:
    Serializable, Comparable<PoolType>

      public enum PoolType
      extends Enum<PoolType>

  An enum for the different thread-pools available within PGX.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `ANALYSIS_POOL` - multi-threaded - executed concurrent to server thread - sequential to each other (new tasks are only submitted if thread pool idling to exploit full parallelism) Make sure there are no side-effects to global state.
    `FAST_TRACK_ANALYSIS_POOL` - single-threaded - executed concurrent to server thread - concurrent to each other Make sure there are no side-effects to global state.
    `IO_POOL` - multi-threaded - executed concurrent to server thread - sequential to each other (new tasks are only submitted if thread pool idling to exploit full parallelism) Make sure there are no side-effects to global state.
    `SERVER_THREAD` - single-threaded - executed sequentially on server thread SERVER_THREAD tasks should be really quick, as they block the server thread.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getName()`
    `String` | `toString()` Alias for `getName()`
    `static PoolType` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static PoolType[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

      `compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### ANALYSIS_POOL

          public static final PoolType ANALYSIS_POOL

      - multi-threaded - executed concurrent to server thread - sequential to each other (new tasks are only submitted if thread pool idling to exploit full parallelism) Make sure there are no side-effects to global state. Side-effects to session state are fine, as there will never be two tasks of the same session be executed concurrently.

    - #### FAST_TRACK_ANALYSIS_POOL

          public static final PoolType FAST_TRACK_ANALYSIS_POOL

      - single-threaded - executed concurrent to server thread - concurrent to each other Make sure there are no side-effects to global state. Side-effects to session state are fine, as there will never be two tasks of the same session be executed concurrently.

    - #### IO_POOL

          public static final PoolType IO_POOL

      - multi-threaded - executed concurrent to server thread - sequential to each other (new tasks are only submitted if thread pool idling to exploit full parallelism) Make sure there are no side-effects to global state. Side-effects to session state are fine, as there will never be two tasks of the same session be executed concurrently.

    - #### SERVER_THREAD

          public static final PoolType SERVER_THREAD

      - single-threaded - executed sequentially on server thread SERVER_THREAD tasks should be really quick, as they block the server thread.

  - ### Method Detail

    - #### getName

          public String getName()

      Returns:
        the name of this thread pool

    - #### toString

          public String toString()

      Alias for `getName()`
      Overrides:
        `toString` in class `Enum<PoolType>`
      Returns:
        the name of this thread pool

    - #### valueOf

          public static PoolType valueOf(String name)

      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
        `name` - the name of the enum constant to be returned.
      Returns:
        the enum constant with the specified name
      Throws:
        `IllegalArgumentException` - if this enum type has no constant with the specified name
        `NullPointerException` - if the argument is null

    - #### values

          public static PoolType[] values()

      Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

          for (PoolType c : PoolType.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

Copyright © 2015. All rights reserved.